Skip to content

Conversation

@shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Aug 23, 2024

User description

Removed a bunch of badge codes that were left over after people added code examples

Description

Removed leftover badge codes from the following files in all translations:

  • finders.md
  • using_selenium.md
  • selenium_manager.md
  • getting_started.md

Motivation and Context

cleans up site

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

documentation


Description

  • Removed erroneous {{< badge-code >}} tags from various documentation files across multiple translations.
  • Cleaned up the documentation by eliminating leftover badge codes, improving readability and presentation.

Changes walkthrough 📝

Relevant files
Documentation
16 files
selenium_manager.en.md
Remove erroneous badge-code tag from selenium_manager.en.md

website_and_docs/content/documentation/selenium_manager.en.md

  • Removed erroneous {{< badge-code >}} tag.
+0/-1     
selenium_manager.ja.md
Remove erroneous badge-code tag from selenium_manager.ja.md

website_and_docs/content/documentation/selenium_manager.ja.md

  • Removed erroneous {{< badge-code >}} tag.
+0/-1     
selenium_manager.pt-br.md
Remove erroneous badge-code tag from selenium_manager.pt-br.md

website_and_docs/content/documentation/selenium_manager.pt-br.md

  • Removed erroneous {{< badge-code >}} tag.
+0/-1     
selenium_manager.zh-cn.md
Remove erroneous badge-code tag from selenium_manager.zh-cn.md

website_and_docs/content/documentation/selenium_manager.zh-cn.md

  • Removed erroneous {{< badge-code >}} tag.
+0/-1     
_index.en.md
Remove erroneous badge-code tags from drivers index.en.md

website_and_docs/content/documentation/webdriver/drivers/_index.en.md

  • Removed erroneous {{< badge-code >}} tags from multiple code tabs.
+0/-4     
_index.ja.md
Remove erroneous badge-code tags from drivers index.ja.md

website_and_docs/content/documentation/webdriver/drivers/_index.ja.md

  • Removed erroneous {{< badge-code >}} tags from multiple code tabs.
+0/-4     
_index.pt-br.md
Remove erroneous badge-code tags from drivers index.pt-br.md

website_and_docs/content/documentation/webdriver/drivers/_index.pt-br.md

  • Removed erroneous {{< badge-code >}} tags from multiple code tabs.
+0/-4     
_index.zh-cn.md
Remove erroneous badge-code tags from drivers index.zh-cn.md

website_and_docs/content/documentation/webdriver/drivers/_index.zh-cn.md

  • Removed erroneous {{< badge-code >}} tags from multiple code tabs.
+0/-4     
first_script.en.md
Remove erroneous badge-code tag from first_script.en.md   

website_and_docs/content/documentation/webdriver/getting_started/first_script.en.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
first_script.ja.md
Remove erroneous badge-code tag from first_script.ja.md   

website_and_docs/content/documentation/webdriver/getting_started/first_script.ja.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
first_script.pt-br.md
Remove erroneous badge-code tag from first_script.pt-br.md

website_and_docs/content/documentation/webdriver/getting_started/first_script.pt-br.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
first_script.zh-cn.md
Remove erroneous badge-code tag from first_script.zh-cn.md

website_and_docs/content/documentation/webdriver/getting_started/first_script.zh-cn.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
using_selenium.en.md
Remove erroneous badge-code tag from using_selenium.en.md

website_and_docs/content/documentation/webdriver/getting_started/using_selenium.en.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
using_selenium.ja.md
Remove erroneous badge-code tag from using_selenium.ja.md

website_and_docs/content/documentation/webdriver/getting_started/using_selenium.ja.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
using_selenium.pt-br.md
Remove erroneous badge-code tag from using_selenium.pt-br.md

website_and_docs/content/documentation/webdriver/getting_started/using_selenium.pt-br.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     
using_selenium.zh-cn.md
Remove erroneous badge-code tag from using_selenium.zh-cn.md

website_and_docs/content/documentation/webdriver/getting_started/using_selenium.zh-cn.md

  • Removed erroneous {{< badge-code >}} tag from Python tab.
+0/-1     

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

@netlify
Copy link

netlify bot commented Aug 23, 2024

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit a65b079

@qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Aug 23, 2024
@qodo-merge-pro
Copy link
Contributor

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No key issues to review

@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Consistency
Remove remaining badge-code tag for consistency across language tabs

Consider removing the remaining {{< badge-code >}} tag in the CSharp tab, as it
seems to be inconsistent with the removal of similar tags in other language tabs.

website_and_docs/content/documentation/webdriver/getting_started/first_script.en.md [238-239]

 {{< tab header="CSharp" >}}
-{{< badge-code >}}
 
  • Apply this suggestion
Suggestion importance[1-10]: 9

Why: The suggestion correctly identifies an inconsistency in the documentation by pointing out the remaining {{< badge-code >}} tag in the CSharp tab, which should be removed for consistency with other language tabs.

9
Remove leftover badge-code tag for consistency in documentation

Remove the remaining {{< badge-code >}} tag in the CSharp tab to maintain
consistency with the changes made in other language tabs and files.

website_and_docs/content/documentation/webdriver/getting_started/first_script.ja.md [241-242]

 {{< tab header="CSharp" >}}
-{{< badge-code >}}
 
  • Apply this suggestion
Suggestion importance[1-10]: 9

Why: This suggestion highlights the need to remove the {{< badge-code >}} tag in the CSharp tab, aligning with similar changes in other language tabs, ensuring consistency across the documentation.

9
Remove unnecessary badge-code tag for documentation consistency

Remove the {{< badge-code >}} tag in the CSharp tab to align with the changes made
in other language tabs and maintain consistency across the documentation.

website_and_docs/content/documentation/webdriver/getting_started/first_script.pt-br.md [240-241]

 {{< tab header="CSharp" >}}
-{{< badge-code >}}
 
  • Apply this suggestion
Suggestion importance[1-10]: 9

Why: The suggestion is valid as it addresses the inconsistency by recommending the removal of the {{< badge-code >}} tag in the CSharp tab, which aligns with the changes made in other language tabs.

9
Remove redundant badge-code tag for uniform documentation structure

Remove the {{< badge-code >}} tag in the CSharp tab to ensure consistency with the
changes made in other language tabs and across different localized versions of the
documentation.

website_and_docs/content/documentation/webdriver/getting_started/first_script.zh-cn.md [253-254]

 {{< tab header="CSharp" >}}
-{{< badge-code >}}
 
  • Apply this suggestion
Suggestion importance[1-10]: 9

Why: This suggestion correctly identifies the need to remove the {{< badge-code >}} tag in the CSharp tab to maintain consistency with other language tabs, ensuring a uniform documentation structure.

9

Copy link
Member

@harsha509 harsha509 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @shbenzer !

@harsha509 harsha509 merged commit 5a6fd07 into SeleniumHQ:trunk Aug 26, 2024
selenium-ci added a commit that referenced this pull request Aug 26, 2024
Co-authored-by: Sri Harsha <12621691+harsha509@users.noreply.github.com> 5a6fd07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Review effort [1-5]: 1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants